Skip to content
/ pycommit Public

PyCommit is a tiny toy that helps developers write better commit messages. It uses OpenAI to generate commit messages that are clear and concise.

License

Notifications You must be signed in to change notification settings

vlin/pycommit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PyCommit

A tiny toy, it might helps you write better commit messages.

PyCommit is a tiny toy that helps developers write better commit messages. It uses OpenAI to generate commit messages that are clear and concise.

screenshot

How to use PyCommit

  • Set the OPENAI_API_KEY environment variable in your shell.

  • Make some changes to your project.

  • Run python3 pycommit.py to use OpenAI to generate a commit message.

  • Review the generated commit message and make any necessary changes.

  • Commit your changes with the generated commit message.

Installation

Clone the repository.

Install the dependencies with pip3 install -r requirements.txt.

Configuration

Set the OPENAI_API_KEY environment variable in your shell.

Contributing

Fork the repository.

Create a new branch for your feature.

Make your changes.

Write tests for your changes.

Run the tests with pytest.

Submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

PyCommit is a tiny toy that helps developers write better commit messages. It uses OpenAI to generate commit messages that are clear and concise.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages